mixme

What is mixme?

Mixme is a utility library for deep merging of objects. It allows you to combine multiple objects into one, handling nested properties and arrays gracefully.

What are mixme's main functionalities?

Deep Merge

This feature allows you to deeply merge two or more objects. Nested properties are merged recursively.

const mixme = require('mixme');
const obj1 = { a: 1, b: { c: 2 } };
const obj2 = { b: { d: 3 } };
const result = mixme.merge(obj1, obj2);
console.log(result); // { a: 1, b: { c: 2, d: 3 } }

Array Merge

This feature allows you to merge arrays within objects. The arrays are concatenated.

const mixme = require('mixme');
const obj1 = { a: [1, 2] };
const obj2 = { a: [3, 4] };
const result = mixme.merge(obj1, obj2);
console.log(result); // { a: [1, 2, 3, 4] }

Custom Merge Function

This feature allows you to provide a custom merge function to define how values should be combined.

const mixme = require('mixme');
const obj1 = { a: 1, b: 2 };
const obj2 = { a: 3, b: 4 };
const customMerge = (a, b) => a + b;
const result = mixme.merge(obj1, obj2, customMerge);
console.log(result); // { a: 4, b: 6 }

Other packages similar to mixme

lodash

Lodash is a popular utility library that provides a wide range of functions for manipulating arrays, objects, and other data types. It includes a `merge` function similar to mixme's deep merge, but also offers many other utilities.

deepmerge

Deepmerge is a library specifically designed for deep merging of JavaScript objects. It is similar to mixme in its core functionality but focuses solely on merging, without additional utilities.

merge

Merge is a simple utility for merging objects. It provides basic deep merge functionality but lacks some of the advanced features and customizability of mixme.

README

Node.js mixme

Merge multiple object recursively. The last object takes precedence over the previous ones. Only objects are merged. Arrays are overwritten.

API

Function merge(...data)

The API is minimalist, pass as many literal objects as you wish, they will all be merged. This function is immutable, the source objects won't be altered.

const {merge} = require('mixme')
const target = merge({a: '1'}, {b: '2'});
// target is {a: '1', b: '2'}

Function mutate(...data)

Use the mutate function to enrich an object. The first argument will be mutated:

const {mutate} = require('mixme')
const source = {a: '1'};
const target = mutate(source, {b: '2'});
// target is the same as source
// source and target are now {a: '1', b: '2'}

Function clone(data)

It is possible to clone a literal object by simply calling mixme with this object as the first argument. Use the clone function in case you wish to clone any type of argument including arrays:

const clone = require('clone')
const target = mixme.clone(['a', 'b'])
// target is now a copy of source

Function is_object_literal(object)

Use the is_object_literal function to ensure an object is literate.

const is_object_literal = require('mixme')
// {} is literate
is_object_literal({})
// error is not literate
is_object_literal(new Error('Catch me'))
// Array is not literate
is_object_literal([])

Function snake_case(object)

Clone a object and convert its properties into snake case.

const snake_case = require('mixme')
const target = snake_case({aA: '1', bB: cC: '2'})
// target is now {a_a: '1', b_b: c_c: '2'}

Example

Create a new object from two objects:

obj1 = { a_key: 'a value', b_key: 'b value'}
obj2 = { b_key: 'new b value'}
result = misc.merge obj1, obj2
assert.eql result.b_key, 'new b value'

Merge an existing object with a second one:

obj1 = { a_key: 'a value', b_key: 'b value'};
obj2 = { b_key: 'new b value'};
result = mixme.mutate obj1, obj2
assert.eql result, obj1
assert.eql obj1.b_key, 'new b value'

Testing

Clone the repo, install the development dependencies and run the tests:

git clone http://github.com/wdavidw/node-mixme.git .
npm install
make test

Contributors

• David Worms: https://github.com/wdavidw

This package is developed by Adaltas.

Changelog

Version 0.3.5

• readme: fix examples